<?php
/**
 * Copyright 2011 MaGdev
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    * The names of the authors may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @package      Mashape API-Documentor
 * @author       Marco Graetsch <info@magdev.de>
 * @copyright    2011 Marco Graetsch.development
 * @license      http://opensource.org/licenses/bsd-license.php New BSD License
 * @link         https://code.google.com/p/apidocumentor/
 */


/**
 * Interface for mashdoc renderer
 *
 * @author magdev
 */
interface Mashdoc_Renderer_Interface
{
	/**
	 * Set the api.xml document
	 *
	 * @param DOMDocument $xml
	 * @return void
	 */
	public function setXml(DOMDocument $xml);
	
	
	/**
	 * Get a string representation of the output
	 *
	 * @return string
	 */
	public function __toString();
	
	
	/**
	 * Render the output
	 *
	 * @return Mashdoc_Metadata_Interface
	 */
	public function render();
	
	
	/**
	 * Set parameters
	 *
	 * @param array|Mashdoc_Metadata_Interface $params
	 * @return Mashdoc_Metadata_Interface
	 */
	public function setParams($params);
	
	
	/**
	 * Get all parameters
	 *
	 * @return array
	 */
	public function getParams();
	
	
	/**
	 * Set a single parameter
	 *
	 * @param string $key
	 * @param mixed $value
	 * @return Mashdoc_Metadata_Interface
	 */
	public function setParam($key, $value);
	
	
	/**
	 * Get a single parameter
	 *
	 * @param string $key
	 * @param mixed $default
	 * @return mixed
	 */
	public function getParam($key, $default = null);
	
	
	/**
	 * Display the generated output
	 *
	 * @param boolean $sendHeader
	 * @return Mashdoc_Metadata_Interface
	 */
	public function output($sendHeader = true);
	
}
